<?php
/**
 * Zend Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://framework.zend.com/license/new-bsd
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category   Zend
 * @package    Zend_Gdata
 * @subpackage YouTube
 * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @version    $Id: Link.php 16971 2009-07-22 18:05:45Z mikaelkael $
 */

/**
 * @see Zend_Gdata_App_Extension_Link
 */
require_once 'Zend/Gdata/App/Extension/Link.php';

/**
 * @see Zend_Gdata_YouTube_Extension_Token
 */
require_once 'Zend/Gdata/YouTube/Extension/Token.php';


/**
 * Specialized Link class for use with YouTube. Enables use of yt extension elements.
 *
 * @category   Zend
 * @package    Zend_Gdata
 * @subpackage YouTube
 * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Gdata_YouTube_Extension_Link extends Zend_Gdata_App_Extension_Link
{

	protected $_token = null;

	/**
	 * Constructs a new Zend_Gdata_Calendar_Extension_Link object.
	 * @see Zend_Gdata_App_Extension_Link#__construct
	 * @param Zend_Gdata_YouTube_Extension_Token $token
	 */
	public function __construct($href = null, $rel = null, $type = null,
	$hrefLang = null, $title = null, $length = null, $token = null)
	{
		$this->registerAllNamespaces(Zend_Gdata_YouTube::$namespaces);
		parent::__construct($href, $rel, $type, $hrefLang, $title, $length);
		$this->_token = $token;
	}

	/**
	 * Retrieves a DOMElement which corresponds to this element and all
	 * child properties.  This is used to build an entry back into a DOM
	 * and eventually XML text for sending to the server upon updates, or
	 * for application storage/persistence.
	 *
	 * @param DOMDocument $doc The DOMDocument used to construct DOMElements
	 * @return DOMElement The DOMElement representing this element and all
	 * child properties.
	 */
	public function getDOM($doc = null, $majorVersion = 1, $minorVersion = null)
	{
		$element = parent::getDOM($doc, $majorVersion, $minorVersion);
		if ($this->_token != null) {
			$element->appendChild($this->_token->getDOM($element->ownerDocument));
		}
		return $element;
	}

	/**
	 * Creates individual Entry objects of the appropriate type and
	 * stores them as members of this entry based upon DOM data.
	 *
	 * @param DOMNode $child The DOMNode to process
	 */
	protected function takeChildFromDOM($child)
	{
		$absoluteNodeName = $child->namespaceURI . ':' . $child->localName;
		switch ($absoluteNodeName) {
			case $this->lookupNamespace('yt') . ':' . 'token':
				$token = new Zend_Gdata_YouTube_Extension_Token();
				$token->transferFromDOM($child);
				$this->_token = $token;
				break;
			default:
				parent::takeChildFromDOM($child);
				break;
		}
	}

	/**
	 * Get the value for this element's token attribute.
	 *
	 * @return Zend_Gdata_YouTube_Extension_Token The token element.
	 */
	public function getToken()
	{
		return $this->_token;
	}

	/**
	 * Set the value for this element's token attribute.
	 *
	 * @param Zend_Gdata_YouTube_Extension_Token $value The desired value for this attribute.
	 * @return Zend_YouTube_Extension_Link The element being modified.
	 */
	public function setToken($value)
	{
		$this->_token = $value;
		return $this;
	}

	/**
	 * Get the value of this element's token attribute.
	 *
	 * @return string The token's text value
	 */
	public function getTokenValue()
	{
		return $this->getToken()->getText();
	}

}
